How to send invites through the API

This guide provides instructions on leveraging the Walr platform API to facilitate the sending of campaigns, including emails and/or SMS.

Creating a Campaign

To initiate campaign transmission through the API, ensure the prior creation of campaigns tailored to the specific type of invite desired (email and/or SMS). This process can be accomplished by accessing the survey within the Walr platform and navigating to the audience tab. Once there, create a campaign, ensuring completion of all requisite details encompassing sender information, provider specifications, and campaign content. Subsequently, save the campaign.

Alternatively, campaigns can be created through the API itself. For more information on API-based campaign creation, refer to the SMS campaign creation documentation or email campaign creation documentation.

Note that the ID of the created campaign is essential for sending invites through the API.

Creating an Audience

There exist two distinct methods for audience creation: within the survey builder or directly during the invitation transmission via the API. Should you opt to create the audience within the platform, it's important to note that the columns within the audience will be fixed, preventing subsequent addition or removal.

Conversely, creating the audience directly within the send invite API call allows for the dynamic addition or removal of columns with each endpoint call. For more details on this functionality, refer to the send invite API documentation.